<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>MimeServlet xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/net/big_oh/common/web/servlets/mime/MimeServlet.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> net.big_oh.common.web.servlets.mime;
<a class="jxr_linenumber" name="2" href="#2">2</a>   
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> Copyright (c) 2008 Dave Wingate dba Big-Oh Software (www.big-oh.net)</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> Permission is hereby granted, free of charge, to any person</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> obtaining a copy of this software and associated documentation</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> files (the "Software"), to deal in the Software without</em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> restriction, including without limitation the rights to use,</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> copy, modify, merge, publish, distribute, sublicense, and/or sell</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> copies of the Software, and to permit persons to whom the</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> Software is furnished to do so, subject to the following</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> conditions:</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> The above copyright notice and this permission notice shall be</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_comment"> included in all copies or substantial portions of the Software.</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <em class="jxr_comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</em>
<a class="jxr_linenumber" name="19" href="#19">19</a>  <em class="jxr_comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES</em>
<a class="jxr_linenumber" name="20" href="#20">20</a>  <em class="jxr_comment"> OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</em>
<a class="jxr_linenumber" name="21" href="#21">21</a>  <em class="jxr_comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT</em>
<a class="jxr_linenumber" name="22" href="#22">22</a>  <em class="jxr_comment"> HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,</em>
<a class="jxr_linenumber" name="23" href="#23">23</a>  <em class="jxr_comment"> WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_comment"> FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_comment"> OTHER DEALINGS IN THE SOFTWARE.</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="27" href="#27">27</a>  
<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> java.io.ByteArrayInputStream;
<a class="jxr_linenumber" name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> java.io.OutputStream;
<a class="jxr_linenumber" name="31" href="#31">31</a>  
<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> javax.servlet.ServletException;
<a class="jxr_linenumber" name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServlet;
<a class="jxr_linenumber" name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a class="jxr_linenumber" name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpSession;
<a class="jxr_linenumber" name="37" href="#37">37</a>  
<a class="jxr_linenumber" name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.Log;
<a class="jxr_linenumber" name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.logging.LogFactory;
<a class="jxr_linenumber" name="40" href="#40">40</a>  
<a class="jxr_linenumber" name="41" href="#41">41</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../net/big_oh/common/web/servlets/mime/MimeServlet.html">MimeServlet</a> <strong class="jxr_keyword">extends</strong> HttpServlet
<a class="jxr_linenumber" name="42" href="#42">42</a>  {
<a class="jxr_linenumber" name="43" href="#43">43</a>  
<a class="jxr_linenumber" name="44" href="#44">44</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Log logger = LogFactory.getLog(MimeServlet.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="45" href="#45">45</a>  
<a class="jxr_linenumber" name="46" href="#46">46</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REQUESTED_RESOURCE_NAME = <span class="jxr_string">"requestedResourceName"</span>;
<a class="jxr_linenumber" name="47" href="#47">47</a>  
<a class="jxr_linenumber" name="48" href="#48">48</a>  	@Override
<a class="jxr_linenumber" name="49" href="#49">49</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doGet(HttpServletRequest req, HttpServletResponse resp) <strong class="jxr_keyword">throws</strong> ServletException, IOException
<a class="jxr_linenumber" name="50" href="#50">50</a>  	{
<a class="jxr_linenumber" name="51" href="#51">51</a>  		doPost(req, resp);
<a class="jxr_linenumber" name="52" href="#52">52</a>  	}
<a class="jxr_linenumber" name="53" href="#53">53</a>  
<a class="jxr_linenumber" name="54" href="#54">54</a>  	@Override
<a class="jxr_linenumber" name="55" href="#55">55</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doPost(HttpServletRequest req, HttpServletResponse resp) <strong class="jxr_keyword">throws</strong> ServletException, IOException
<a class="jxr_linenumber" name="56" href="#56">56</a>  	{
<a class="jxr_linenumber" name="57" href="#57">57</a>  		logger.info(getServletConfig().getServletName() + <span class="jxr_string">" invoked.  Requested mime resource: "</span> + req.getParameter(REQUESTED_RESOURCE_NAME));
<a class="jxr_linenumber" name="58" href="#58">58</a>  
<a class="jxr_linenumber" name="59" href="#59">59</a>  		<em class="jxr_comment">// Get the name of the requested resource</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  		String requestedResourceName = req.getParameter(REQUESTED_RESOURCE_NAME);
<a class="jxr_linenumber" name="61" href="#61">61</a>  
<a class="jxr_linenumber" name="62" href="#62">62</a>  		<strong class="jxr_keyword">if</strong> (requestedResourceName == <strong class="jxr_keyword">null</strong> || requestedResourceName.equals(<span class="jxr_string">""</span>))
<a class="jxr_linenumber" name="63" href="#63">63</a>  		{
<a class="jxr_linenumber" name="64" href="#64">64</a>  			logger.error(<span class="jxr_string">"Called "</span> + getServletConfig().getServletName() + <span class="jxr_string">" without providing a parameter for '"</span> + REQUESTED_RESOURCE_NAME + <span class="jxr_string">"'"</span>);
<a class="jxr_linenumber" name="65" href="#65">65</a>  			resp.setStatus(HttpServletResponse.SC_BAD_REQUEST);
<a class="jxr_linenumber" name="66" href="#66">66</a>  			<strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="67" href="#67">67</a>  		}
<a class="jxr_linenumber" name="68" href="#68">68</a>  
<a class="jxr_linenumber" name="69" href="#69">69</a>  		<em class="jxr_comment">// Ensure that the user is allowed to access the requested resource</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>  		<strong class="jxr_keyword">if</strong> (!isCanUserAccessRequestedResource(requestedResourceName, req.getSession(<strong class="jxr_keyword">true</strong>)))
<a class="jxr_linenumber" name="71" href="#71">71</a>  		{
<a class="jxr_linenumber" name="72" href="#72">72</a>  			resp.setStatus(HttpServletResponse.SC_FORBIDDEN);
<a class="jxr_linenumber" name="73" href="#73">73</a>  			<strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="74" href="#74">74</a>  		}
<a class="jxr_linenumber" name="75" href="#75">75</a>  
<a class="jxr_linenumber" name="76" href="#76">76</a>  		<em class="jxr_comment">// Get a byte array representation of the resource to be returned in the</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  		<em class="jxr_comment">// response</em>
<a class="jxr_linenumber" name="78" href="#78">78</a>  		byte[] resourceBytes = getMimeResourceBytes(requestedResourceName);
<a class="jxr_linenumber" name="79" href="#79">79</a>  
<a class="jxr_linenumber" name="80" href="#80">80</a>  		<strong class="jxr_keyword">if</strong> (resourceBytes == <strong class="jxr_keyword">null</strong> || resourceBytes.length == 0)
<a class="jxr_linenumber" name="81" href="#81">81</a>  		{
<a class="jxr_linenumber" name="82" href="#82">82</a>  			logger.error(<span class="jxr_string">"No resource found under the name \&quot;"</span> + requestedResourceName + <span class="jxr_string">"\&quot;"</span>);
<a class="jxr_linenumber" name="83" href="#83">83</a>  			resp.setStatus(HttpServletResponse.SC_NOT_FOUND);
<a class="jxr_linenumber" name="84" href="#84">84</a>  			<strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="85" href="#85">85</a>  		}
<a class="jxr_linenumber" name="86" href="#86">86</a>  
<a class="jxr_linenumber" name="87" href="#87">87</a>  		<em class="jxr_comment">// Set content length for the response</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>  		resp.setContentLength(resourceBytes.length);
<a class="jxr_linenumber" name="89" href="#89">89</a>  
<a class="jxr_linenumber" name="90" href="#90">90</a>  		<em class="jxr_comment">// Get the MIME type for the resource</em>
<a class="jxr_linenumber" name="91" href="#91">91</a>  		String mimeType = getMimeType(requestedResourceName);
<a class="jxr_linenumber" name="92" href="#92">92</a>  
<a class="jxr_linenumber" name="93" href="#93">93</a>  		<strong class="jxr_keyword">if</strong> (mimeType == <strong class="jxr_keyword">null</strong> || mimeType.equals(<span class="jxr_string">""</span>))
<a class="jxr_linenumber" name="94" href="#94">94</a>  		{
<a class="jxr_linenumber" name="95" href="#95">95</a>  			logger.error(<span class="jxr_string">"Failed to get MIME type for the requested resource."</span>);
<a class="jxr_linenumber" name="96" href="#96">96</a>  			resp.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
<a class="jxr_linenumber" name="97" href="#97">97</a>  			<strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="98" href="#98">98</a>  		}
<a class="jxr_linenumber" name="99" href="#99">99</a>  
<a class="jxr_linenumber" name="100" href="#100">100</a> 		<em class="jxr_comment">// Set the content type for the response</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> 		resp.setContentType(mimeType);
<a class="jxr_linenumber" name="102" href="#102">102</a> 
<a class="jxr_linenumber" name="103" href="#103">103</a> 		<em class="jxr_comment">// Control the HTTP caching of the response</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> 		<em class="jxr_comment">// This setting controls how frequently the cached resource is</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> 		<em class="jxr_comment">// revalidated (which is not necessarily the same as reloaded)</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> 		resp.setHeader(<span class="jxr_string">"Cache-Control"</span>, <span class="jxr_string">"max-age="</span> + getMaxAgeInSeconds(requestedResourceName));
<a class="jxr_linenumber" name="107" href="#107">107</a> 
<a class="jxr_linenumber" name="108" href="#108">108</a> 		<em class="jxr_comment">// Use streams to return the requested resource</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> 		ByteArrayInputStream in = <strong class="jxr_keyword">new</strong> ByteArrayInputStream(resourceBytes);
<a class="jxr_linenumber" name="110" href="#110">110</a> 		OutputStream out = resp.getOutputStream();
<a class="jxr_linenumber" name="111" href="#111">111</a> 
<a class="jxr_linenumber" name="112" href="#112">112</a> 		byte[] buf = <strong class="jxr_keyword">new</strong> byte[1024];
<a class="jxr_linenumber" name="113" href="#113">113</a> 		<strong class="jxr_keyword">int</strong> count = 0;
<a class="jxr_linenumber" name="114" href="#114">114</a> 		<strong class="jxr_keyword">while</strong> ((count = in.read(buf)) &gt;= 0)
<a class="jxr_linenumber" name="115" href="#115">115</a> 		{
<a class="jxr_linenumber" name="116" href="#116">116</a> 			out.write(buf, 0, count);
<a class="jxr_linenumber" name="117" href="#117">117</a> 		}
<a class="jxr_linenumber" name="118" href="#118">118</a> 
<a class="jxr_linenumber" name="119" href="#119">119</a> 		in.close();
<a class="jxr_linenumber" name="120" href="#120">120</a> 		out.close();
<a class="jxr_linenumber" name="121" href="#121">121</a> 
<a class="jxr_linenumber" name="122" href="#122">122</a> 	}
<a class="jxr_linenumber" name="123" href="#123">123</a> 
<a class="jxr_linenumber" name="124" href="#124">124</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">	 * @param requestedResourceName</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">	 * @param session</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">	 * @return Returns a boolean indicating whether the user may access the</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">	 *         requested resource.</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="130" href="#130">130</a> 	<strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isCanUserAccessRequestedResource(String requestedResourceName, HttpSession session)
<a class="jxr_linenumber" name="131" href="#131">131</a> 	{
<a class="jxr_linenumber" name="132" href="#132">132</a> 		<strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="133" href="#133">133</a> 	}
<a class="jxr_linenumber" name="134" href="#134">134</a> 
<a class="jxr_linenumber" name="135" href="#135">135</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">	 * @param requestedResourceName</em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment">	 * @return Returns the numbers of seconds after which the response should be</em>
<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment">	 *         considered stale by HTTP caches.</em>
<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="140" href="#140">140</a> 	<strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> getMaxAgeInSeconds(String requestedResourceName)
<a class="jxr_linenumber" name="141" href="#141">141</a> 	{
<a class="jxr_linenumber" name="142" href="#142">142</a> 		<em class="jxr_comment">// return 1 hour by default</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> 		<strong class="jxr_keyword">return</strong> 60 * 60;
<a class="jxr_linenumber" name="144" href="#144">144</a> 	}
<a class="jxr_linenumber" name="145" href="#145">145</a> 
<a class="jxr_linenumber" name="146" href="#146">146</a> 	@Override
<a class="jxr_linenumber" name="147" href="#147">147</a> 	<strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> getLastModified(HttpServletRequest req)
<a class="jxr_linenumber" name="148" href="#148">148</a> 	{
<a class="jxr_linenumber" name="149" href="#149">149</a> 		String requestedResourceName = req.getParameter(REQUESTED_RESOURCE_NAME);
<a class="jxr_linenumber" name="150" href="#150">150</a> 
<a class="jxr_linenumber" name="151" href="#151">151</a> 		<strong class="jxr_keyword">if</strong> (requestedResourceName == <strong class="jxr_keyword">null</strong> || requestedResourceName.equals(<span class="jxr_string">""</span>))
<a class="jxr_linenumber" name="152" href="#152">152</a> 		{
<a class="jxr_linenumber" name="153" href="#153">153</a> 			<strong class="jxr_keyword">return</strong> -1;
<a class="jxr_linenumber" name="154" href="#154">154</a> 		}
<a class="jxr_linenumber" name="155" href="#155">155</a> 		<strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="156" href="#156">156</a> 		{
<a class="jxr_linenumber" name="157" href="#157">157</a> 			<strong class="jxr_keyword">return</strong> getLastModified(requestedResourceName);
<a class="jxr_linenumber" name="158" href="#158">158</a> 		}
<a class="jxr_linenumber" name="159" href="#159">159</a> 	}
<a class="jxr_linenumber" name="160" href="#160">160</a> 
<a class="jxr_linenumber" name="161" href="#161">161</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment">	 * @param requestedResourceName</em>
<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment">	 * @return Returns the system time when the requested resource was last</em>
<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment">	 *         modified. A return value of -1 means that the resource is always</em>
<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment">	 *         "stale."</em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> 	<strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">long</strong> getLastModified(String requestedResourceName);
<a class="jxr_linenumber" name="168" href="#168">168</a> 
<a class="jxr_linenumber" name="169" href="#169">169</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment">	 * If you're returning a resource for which you know the original file name,</em>
<a class="jxr_linenumber" name="171" href="#171">171</a> <em class="jxr_javadoccomment">	 * this method cold easily be implemented by returning:</em>
<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment">	 * getServletContext().getMimeType(originalFileName.toLowerCase());</em>
<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment">	 * @param requestedResourceName</em>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment">	 * @return Returns a String representation of the resource's MIME type.</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> 	<strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String getMimeType(String requestedResourceName);
<a class="jxr_linenumber" name="179" href="#179">179</a> 
<a class="jxr_linenumber" name="180" href="#180">180</a> 	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment">	 * @param requestedResourceName</em>
<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment">	 * @return Returns the bytes for the requested resource.</em>
<a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="184" href="#184">184</a> 	<strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> byte[] getMimeResourceBytes(String requestedResourceName) <strong class="jxr_keyword">throws</strong> IOException;
<a class="jxr_linenumber" name="185" href="#185">185</a> 
<a class="jxr_linenumber" name="186" href="#186">186</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

